WebMoney決済 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様(.idPass)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却

EntryTranWebmoney 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字6桁
利用金額

利用可能決済金額をご確認ください。

Tax 半角数字6桁
税送料

利用可能決済金額をご確認ください。

URL
/payment/EntryTranWebmoney.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000&Tax=100
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranWebmoney 決済実行

お客様が入力した情報でWebMoneyセンターと通信を行い、決済要求結果を返します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値を設定します。

ItemName 必須 全半角40バイト
商品・サービス名

WebMoneyの決済画面に表示する商品名を設定します。

CustomerName 必須 全半角40バイト
氏名

お客様の氏名を設定します。

決済開始メールに表示されます。

MailAddress 半角英数記号256桁
メールアドレス

決済開始メール送付先のお客様のメールアドレスを設定します。

ShopMailAddress 半角英数記号256桁
加盟店メールアドレス

お客様へ決済開始メールを送信する際に加盟店様にも送信する場合のメールアドレスを設定してください。
(BCCで設定されます。)

省略時は、ショップ情報に設定されたメールアドレスで処理されます。

PaymentTermDay 半角数字2桁
支払期限日数

省略時は、ショップ情報に設定された支払期限日数で処理されます。

RedirectURL 半角英数記号256桁
リダイレクトURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを指定します。
WebMoney上でお客様が支払操作を完了した場合や、キャンセルした場合に指定されたURLに結果を送信します。
結果はリダイレクト経由で送信します。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

ClientFieldFlag 半角数字1桁
加盟店自由項目返却フラグ

以下のいずれかを設定します。
0:返却しない(デフォルト)
1:返却する

URL
/payment/ExecTranWebmoney.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&ItemName=テストギフト&CustomerName=決済太郎&MailAddress=test@example.com&ShopMailAddress=testshop@example.com&PaymentTermDay=10&RedirectURL=https://example.com/receive&ClientField1=&ClientField2=&ClientField3=&ClientFieldFlag=0
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

PaymentTerm 半角数字14桁 固定
支払期限日時

お客様の払込期限を返却します。
yyyyMMddHHmmss書式

TranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式

CheckString 半角英数32桁
MD5ハッシュ

出力内容のOrderID~TranDateとショップパスワードをベースにしたハッシュ値を返却します。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&PaymentTerm=20210308125035&TranDate=20201225091313&CheckString=83213ec758582c28439aa0284d6c6b6f&ClientField1=&ClientField2=&ClientField3=
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

WebmoneyStart 支払手続き開始IF呼び出し

WebMoney決済において、お客様をWebMoneyの決済画面へと遷移させる必要があります。
当サービスから送信される決済開始メールを利用する場合は、加盟店様で下記内容を実装する必要はございません。
加盟店様のサイトから画面遷移させる場合は、お客様を当サービスの支払手続き開始IFに誘導してください。
当サービスは、お客様をWebMoneyの決済画面に誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

URL
/payment/WebmoneyStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705
リダイレクトページサンプル
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="WebmoneyStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          WebMoneyの決済画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document.WebmoneyStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

決済結果受信

WebMoneyセンターから、当サービスに支払操作結果が通知されます。
支払操作結果は、お客様が支払操作を完了した場合と支払操作をキャンセルした場合に通知されます。
※ブラウザを×ボタンで閉じた場合は、通知されません。
当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。
※リダイレクトURLが指定されていない場合は、当サービスの購入完了画面またはキャンセル画面を表示します。

レスポンス
正常
ShopID 半角英数13桁
ショップID

OrderID 半角英数記号27桁
オーダーID

Status
現状態

該当取引の取引状態を返却します。
PAYSUCCESS:決済完了
PAYFAIL:決済失敗
REQSUCCESS:要求成功

TranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式

ManagementNo 半角英数16桁
管理番号

購入に使用されたWebMoneyの管理番号

SettleCode 半角英数16桁
決済コード

WebMoneyセンターが返却した決済コード

PayCancel 半角英数25桁
キャンセル区分

以下のいずれかを返却します。
1:支払操作がキャンセルされた場合
0:その他

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

7:WebMoney

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=7
レスポンス
正常
Status
現状態

UNPROCESSED:未決済
REQSUCCESS:要求成功
PAYSTART:決済開始
PAYSUCCESS:決済完了
PAYFAIL:決済失敗
EXPIRED:期限切れ
RETURN:返品

ProcessDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

AccessID 半角英数32桁 固定
取引ID
AccessPass 半角英数32桁 固定
取引パスワード
Amount 半角数字10桁
利用金額
Tax 半角数字10桁
税送料
Currency 半角英字3桁
通貨コード

決済に利用された通貨を返却します。

ClientField1 全半角100バイト
加盟店自由項目1
ClientField2 全半角100バイト
加盟店自由項目2
ClientField3 全半角100バイト
加盟店自由項目3
PayType 半角数字2桁
決済方法

7:WebMoney

PaymentTerm 半角数字14桁
支払期限日時

yyyyMMddHHmmss書式

WebMoneyManagementNo 16桁
管理番号

WebMoneySettleCode 25桁
決済コード

WebMoneyセンターが返却した決済コード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
Status=PAYSUCCESS&ProcessDate=20210308125035&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=100&SiteID=&Currency=JPY&ClientField1=&ClientField2=&ClientField3=&PayType=7&PaymentTerm=20210308125035&WebMoneyManagementNo=20221109090007&WebMoneySettleCode=SCI202211090000KS000000&
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001